<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>aiengine: XAieDma_Shim Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">aiengine
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('struct_x_aie_dma___shim.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">XAieDma_Shim Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>This typedef is the Shim DMA instance.  
 <a href="struct_x_aie_dma___shim.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ad6a1d9950964039d361f567ffc0706d4"><td class="memItemLeft" align="right" valign="top">u64&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_aie_dma___shim.html#ad6a1d9950964039d361f567ffc0706d4">BaseAddress</a></td></tr>
<tr class="memdesc:ad6a1d9950964039d361f567ffc0706d4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Shim DMA base address pointing to the BD0 location.  <a href="#ad6a1d9950964039d361f567ffc0706d4">More...</a><br/></td></tr>
<tr class="separator:ad6a1d9950964039d361f567ffc0706d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad4b3e9869cfc58001194358287be284a"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_aie_dma___shim.html#ad4b3e9869cfc58001194358287be284a">BdStart</a> [XAIEDMA_SHIM_MAX_NUM_CHANNELS]</td></tr>
<tr class="memdesc:ad4b3e9869cfc58001194358287be284a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Start BD value for all the 4 channels.  <a href="#ad4b3e9869cfc58001194358287be284a">More...</a><br/></td></tr>
<tr class="separator:ad4b3e9869cfc58001194358287be284a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a790f5b4ebc19ae5c12402ba292b9eda6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_aie_dma___shim_bd.html">XAieDma_ShimBd</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_aie_dma___shim.html#a790f5b4ebc19ae5c12402ba292b9eda6">Descrs</a> [XAIEDMA_SHIM_MAX_NUM_DESCRS]</td></tr>
<tr class="memdesc:a790f5b4ebc19ae5c12402ba292b9eda6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Data structure to hold the 16 descriptors of the Shim DMA.  <a href="#a790f5b4ebc19ae5c12402ba292b9eda6">More...</a><br/></td></tr>
<tr class="separator:a790f5b4ebc19ae5c12402ba292b9eda6"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This typedef is the Shim DMA instance. </p>
<p>User is required to allocate memory for this Shim DMA instance and a pointer of the same is passed to the Shim DMA driver functions. Each Shim DMA in the array is required to have its own and unique instance structure. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ad6a1d9950964039d361f567ffc0706d4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u64 XAieDma_Shim::BaseAddress</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Shim DMA base address pointing to the BD0 location. </p>

<p>Referenced by <a class="el" href="xaiedma__shim_8h.html#a11062c700e5d4d8fac5807d0fa76aea2">XAieDma_ShimBdWrite()</a>, <a class="el" href="xaiedma__shim_8h.html#a34e7d834009eaa71a3b7bc3b8f253e4f">XAieDma_ShimInitialize()</a>, <a class="el" href="xaiedma__shim_8h.html#a5b482fc7277443d7074300c416b11dbb">XAieDma_ShimPendingBdCount()</a>, <a class="el" href="xaiedma__shim_8h.html#aa2bd7444a7216113d5944f85fcd141de">XAieDma_ShimSoftInitialize()</a>, and <a class="el" href="xaiedma__shim_8h.html#a3b012a58e4f6e8f444a37239adfa744f">XAieDma_ShimWaitDone()</a>.</p>

</div>
</div>
<a class="anchor" id="ad4b3e9869cfc58001194358287be284a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAieDma_Shim::BdStart[XAIEDMA_SHIM_MAX_NUM_CHANNELS]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Start BD value for all the 4 channels. </p>

</div>
</div>
<a class="anchor" id="a790f5b4ebc19ae5c12402ba292b9eda6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct_x_aie_dma___shim_bd.html">XAieDma_ShimBd</a> XAieDma_Shim::Descrs[XAIEDMA_SHIM_MAX_NUM_DESCRS]</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Data structure to hold the 16 descriptors of the Shim DMA. </p>

<p>Referenced by <a class="el" href="xaiedma__shim_8h.html#a8169c137146f59ac65dead098156d4b8">XAieDma_ShimBdClear()</a>, <a class="el" href="xaiedma__shim_8h.html#af3534a5ead9673ad52d818280ed36d25">XAieDma_ShimBdSetAddr()</a>, <a class="el" href="xaiedma__shim_8h.html#a3e436b1de2270c7c15ff037c178a8dd9">XAieDma_ShimBdSetAxi()</a>, <a class="el" href="xaiedma__shim_8h.html#adf033fa0b7286826121554b57434ccc5">XAieDma_ShimBdSetLock()</a>, <a class="el" href="xaiedma__shim_8h.html#a215fa9a9a694fbb29561f04ebc536c11">XAieDma_ShimBdSetNext()</a>, <a class="el" href="xaiedma__shim_8h.html#a2796f476718fc8942c455e3fd1457478">XAieDma_ShimBdSetPkt()</a>, and <a class="el" href="xaiedma__shim_8h.html#a11062c700e5d4d8fac5807d0fa76aea2">XAieDma_ShimBdWrite()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
